cs-salesforce-sapi

Esta sección describe los atributos y uso del servicio API cs-salesforce-sapi.

💂️ Información Base

• Título de la API: cs-salesforce-sapi
• Versión: 1.0.0
• URL Base: https://cs-salesforce-sapi-{env}-v1.us-e1.cloudhub.io/api/Reemplaza {env} con:
  • dev (Desarrollo)
  • qa (Aseguramiento de Calidad)
  • prod (Producción)

🔑 Autenticación

La API implementa dos esquemas de seguridad:

1. client-id-enforcement
2. OAuth2

Encabezados Requeridos

• client_id
  • Longitud: 32 - 36 caracteres
  • Ejemplo: 123e4567-e89b-12d3-a456-426614174000
• Authorization
  • Formato: Token Bearer
  • Ejemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

📌 Estos encabezados son requeridos en todas las solicitudes.

📊 Encabezados Comunes

La mayoría de endpoints en esta API requieren los siguientes encabezados de solicitud estándar:

Endpoints específicos pueden requerir encabezados adicionales. Consulta la documentación detallada del endpoint para requisitos específicos.

📑 Formato de Solicitud y Respuesta

Formato de Solicitud

La API soporta los siguientes formatos de solicitud:

• application/json - Para cargas útiles JSON
• application/octet-stream - Para cargas de archivos binarios

Formato de Respuesta

La API principalmente retorna respuestas en:

• application/json - Para respuestas de datos estructurados
• application/octet-stream - Para descargas de archivos

Cada respuesta incluye códigos de estado HTTP y encabezados apropiados.

📁 Resumen de Estructura de API

Esta API está organizada en varias áreas funcionales:

1. Órdenes de Trabajo - Gestión de órdenes de trabajo para servicios
2. Servicios de Archivos - Servicios de almacenamiento y recuperación de archivos
3. Gestión de Clientes - Manejo de información de clientes
4. Integración IVR - Integración con sistema de Respuesta de Voz Interactiva
5. Gestión de Documentos - Adjuntar archivos y consulta
6. Manejo de PQR - Gestión de Peticiones, Quejas y Reclamos
7. Procesamiento de Reclamos - Presentación de reclamos y reportes
8. Programación de Citas - Gestión de citas
9. Gestión de Casos - Operaciones de casos de Salesforce
10. Habeas Data - Autorizaciones de procesamiento de datos personales
11. Integración Senda - Operaciones para el sistema Senda

Para información detallada sobre cada endpoint, incluyendo formatos de solicitud/respuesta y parámetros, consulta la documentación específica del endpoint.

🔐 Esquemas de Seguridad

Aplicación de Client ID

OAuth2

La API utiliza tanto client_id-enforcement como OAuth2 como esquemas de seguridad. Todas las solicitudes deben incluir tanto un client_id válido como un token Bearer OAuth2 en los encabezados de la solicitud.

⚠️ Códigos de Error

Todos los endpoints de la API implementan manejo común de códigos de error HTTP según se define en la especificación de la API.

📚 Ejemplo de Documentación de Endpoint

/claims

Presentar indemnizaciones en Salesforce.

• URL: https://cs-salesforce-sapi-{env}-v1.us-e1.cloudhub.io/api/claims
• Método: POST
• Autenticación: client_id y OAuth2
• Encabezados Requeridos:
  • Content-Type: application/json
  • Accept: application/json
  • client_id: [tu-client-id]
  • Authorization: Bearer [tu-token]

Ejemplo de Solicitud:

curl -X POST \
  https://cs-salesforce-sapi-prod-v1.us-e1.cloudhub.io/api/claims \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'client_id: 123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  -d '{
    "claimId": "CL-12345",
    "policyNumber": "POL-67890",
    "claimDate": "2025-05-01",
    "claimType": "Accident",
    "description": "Vehicle collision at intersection",
    "claimAmount": 5000.00,
    "claimantInfo": {
      "documentType": 1,
      "documentNumber": "79533115",
      "name": "John Doe",
      "contactNumber": "+573102345678"
    }
  }'

Ejemplo de Respuesta:

{
  "status": "success",
  "data": {
    "claimReference": "REF-CL-98765",
    "submissionDate": "2025-05-13T16:20:10Z",
    "estimatedResponseTime": "48 hours",
    "trackingUrl": "https://claims.colmena.com/track/REF-CL-98765"
  }
}

📌 Nota: Este es solo un ejemplo de endpoint. La API contiene múltiples endpoints como se lista en la sección de Resumen de Estructura de API. Para información detallada sobre otros endpoints, por favor consulta la documentación completa de la API.

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

• Documentación actualizada por última vez: Septiembre 2025
• Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services